/*
 * Copyright (C) 2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package fathom.rest.controller;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Specifies the response content-type can be specified by a request uri
 * suffix that matches a content-type generated by a registered ContentTypeEngine.
 *
 * For example, "/fruit/1.json" would match the "application/json" content-type
 * and thus the response would be set to "application/json".
 *
 * Extension types are also supported.  For example "/fruit/1.yaml" would match
 * the "application/x-yaml" content-type and thus the response would be set to
 * "application/x-yaml".
 *
 * @author James Moger
 */
@Documented
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ContentTypeBySuffix {
    // Specify that a content-type suffix is required (e.g. ".json" or ".xml").
    // By default a suffix is not required.
    boolean required() default false;
}